Redirect chains occur when there are at least two redirects between the initial URL and the destination URL. For example, if page A redirects to page B which redirects to page C, such a series of redirects is considered a redirect chain. Sometimes, if page B redirects back to page A, the redirect chain becomes closed and is considered a redirect loop.
This endpoint will provide you with a full list of redirect URLs that form redirect chains. Using the Redirect Сhains endpoint, you’ll be able to quickly identify and trace down multiple redirects issues.
Instead of ‘login’ and ‘password’ use your credentials from https://app.dataforseo.com/api-dashboard
# Instead of 'login' and 'password' use your credentials from https://app.dataforseo.com/api-dashboard \
login="login" \
password="password" \
cred="$(printf ${login}:${password} | base64)" \
curl --location --request POST "https://api.dataforseo.com/v3/on_page/redirect_chains" \
--header "Authorization: Basic ${cred}" \
--header "Content-Type: application/json" \
--data-raw "[
{
"id": "03051327-4536-0216-1000-3b458a2cfcca",
"url": "https://test_rdr.dataforseo.com/a/"
}
]"
<?php
// You can download this file from here https://cdn.dataforseo.com/v3/examples/php/php_RestClient.zip
require('RestClient.php');
$api_url = 'https://api.dataforseo.com/';
// Instead of 'login' and 'password' use your credentials from https://app.dataforseo.com/api-dashboard
$client = new RestClient($api_url, null, 'login', 'password');
$post_array = array();
// simple way to get a result
$post_array[] = array(
"id" => "03051327-4536-0216-1000-3b458a2cfcca",
"url" => "https://test_rdr.dataforseo.com/a/"
);
try {
// POST /v3/on_page/redirect_chains
// the full list of possible parameters is available in documentation
$result = $client->post('/v3/on_page/redirect_chains', $post_array);
print_r($result);
// do something with post result
} catch (RestClientException $e) {
echo "\n";
print "HTTP code: {$e->getHttpCode()}\n";
print "Error code: {$e->getCode()}\n";
print "Message: {$e->getMessage()}\n";
print $e->getTraceAsString();
echo "\n";
}
$client = null;
?>
from random import Random
from client import RestClient
# You can download this file from here https://api.dataforseo.com/v3/_examples/python/_python_Client.zip
client = RestClient("login", "password")
post_data = dict()
# simple way to get a result
post_data[len(post_data)] = dict(
id="03051327-4536-0216-1000-3b458a2cfcca",
url="https://test_rdr.dataforseo.com/a/"
)
# POST /v3/on_page/redirect_chains
# the full list of possible parameters is available in documentation
response = client.post("/v3/on_page/redirect_chains", post_data)
# you can find the full list of the response codes here https://docs.dataforseo.com/v3/appendix/errors
if response["status_code"] == 20000:
print(response)
# do something with result
else:
print("error. Code: %d Message: %s" % (response["status_code"], response["status_message"]))
using Newtonsoft.Json;
using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
namespace DataForSeoDemos
{
public static partial class Demos
{
public static async Task on_page_redirect_chains()
{
var httpClient = new HttpClient
{
BaseAddress = new Uri("https://api.dataforseo.com/"),
// Instead of 'login' and 'password' use your credentials from https://app.dataforseo.com/api-dashboard
DefaultRequestHeaders = { Authorization = new AuthenticationHeaderValue("Basic", Convert.ToBase64String(Encoding.ASCII.GetBytes("login:password"))) }
};
var postData = new List<object>();
// simple way to get a result
postData.Add(new
{
id = "03051327-4536-0216-1000-3b458a2cfcca",
url = "https://test_rdr.dataforseo.com/a/"
});
// POST /v3/on_page/redirect_chains
// the full list of possible parameters is available in documentation
var taskPostResponse = await httpClient.PostAsync("/v3/on_page/redirect_chains", new StringContent(JsonConvert.SerializeObject(postData)));
var result = JsonConvert.DeserializeObject<dynamic>(await taskPostResponse.Content.ReadAsStringAsync());
// you can find the full list of the response codes here https://docs.dataforseo.com/v3/appendix/errors
if (result.status_code == 20000)
{
// do something with result
Console.WriteLine(result);
}
else
Console.WriteLine($"error. Code: {result.status_code} Message: {result.status_message}");
}
}
}
The above command returns JSON structured like this:
All POST data should be sent in the JSON format (UTF-8 encoding). The task setting is done using the POST method. When setting a task, you should send all task parameters in the task array of the generic POST array.
Description of the fields for setting a task:
Field name
Type
Description
id
string
ID of the task required field
you can get this ID in the response of the Task POST endpoint
example:
“07131248-1535-0216-1000-17384017ad04”
url
string
page URL
optional field
absolute URL of the target page
if you use this field, the API response will return only redirect chains which contain the specified URL
limit
integer
the maximum number of returned redirect chains
optional field
default value: 100
maximum value: 1000
offset
integer
offset in the results array of returned redirect chains
optional field
default value: 0
if you specify the 10 value, the first ten redirect chains in the results array will be omitted and the data will be provided for the successive redirect chains
filters
array
array of results filtering parameters
optional field you can use only one filtering parameter with this endpoint
the following filtering parameter is supported: is_redirect_loop
the following operators are supported: regex, not_regex, =, <>
examples: ["is_redirect_loop","=","true"]
["is_redirect_loop","<>","false"]
tag
string
user-defined task identifier
optional field the character limit is 255
you can use this parameter to identify the task and match it with the result
you will find the specified tag value in the data object of the response
As a response of the API server, you will receive JSON-encoded data containing a tasks array with the information specific to the set tasks.
Description of the fields in the results array:
Field name
Type
Description
version
string
the current version of the API
status_code
integer
general status code
you can find the full list of the response codes here Note: we strongly recommend designing a necessary system for handling related exceptional or error conditions
status_message
string
general informational message
you can find the full list of general informational messages here
time
string
execution time, seconds
cost
float
total tasks cost, USD
tasks_count
integer
the number of tasks in the tasks array
tasks_error
integer
the number of tasks in the tasks array returned with an error
tasks
array
array of tasks
id
string
task identifier unique task identifier in our system in the UUID format
status_code
integer
status code of the task
generated by DataForSEO; can be within the following range: 10000-60000
you can find the full list of the response codes here
status_message
string
informational message of the task
you can find the full list of general informational messages here
time
string
execution time, seconds
cost
float
cost of the task, USD
result_count
integer
number of elements in the result array
path
array
URL path
data
object
contains the same parameters that you specified in the POST request
result
array
array of results
crawl_progress
string
status of the crawling session
possible values: in_progress, finished
crawl_status
object
details of the crawling session
max_crawl_pages
integer
maximum number of pages to crawl
indicates the max_crawl_pages limit you specified when setting a task
pages_in_queue
integer
number of pages that are currently in the crawling queue
pages_crawled
integer
number of crawled pages
total_items_count
integer
total number of relevant items in the database
items_count
integer
number of items in the results array
items
array
items array
is_redirect_loop
bool
indicates if redirects in chain start and end at the same URL
if true, the last URL from the chain redirects back to the original URL
chain
array
contains links that form a chain
type
string
type of the link = ‘redirect’
HTTP redirect with 3xx status code
domain_from
string
referring domain
the link was found on this domain
domain_to
string
referenced domain
the link is pointing to this domain
page_from
string
referring page
relative URL of the page on which the link was found
page_to
string
referenced page
relative URL of the page to which the link is pointing
link_from
string
referring page
absolute URL of the page on which the link was found
link_to
string
referenced page
absolute URL of the page to which the link is pointing
dofollow
boolean
indicates whether the link is dofollow
if the value is true, the link doesn’t have a rel="nofollow" attribute
direction of the link
possible values: internal, external
is_broken
boolean
link is broken
indicates whether a link is directing to a broken page or resource
is_link_relation_conflict
boolean
indicates that the link may have a conflict with another link
if true, at least one link pointing to the URL in link_to has a rel="nofollow" attribute and at least one is dofollow